Migrate a Bid Model
Overview
The Definitions and API Comparison tables highlight the main terminology, actions, and API methods for managing Bid Modeling. Select an endpoint from IQM or Xandr to review that platform's relevant API documentation. By comparing APIs, you can migrate your Bid Modeling workflows from Xandr to IQM.
Definitions
| IQM | Xandr | Description |
|---|---|---|
| Bid Model | Custom Model | The set of optimizations applied to a Campaign or Insertion Order. These optimizations control where ads appear, and define their priorities, bids, and budget allocation. |
| Bid Model Data | Bid Value | A Bid Model setting that adjusts a Campaign's base bid based on specified parameters. |
| Dimension | Components | A property in digital advertising used to categorize, filter, or analyze audiences, Campaigns or inventories. It serves as a targeting parameter for advertisers, specifying where an ad appears. |
| Bid Modifier | Bid Modifier | A multiplier applied to a base bid. |
| Spend Ratio | Adaptive Pacing | Determines how the Campaign budget is distributed across targeting dimensions. |
| Dimension Priority | A setting that dictates the order in which a Campaign should attempt to deliver impressions based on the available budget. |
info
IQM's Bid Model currently supports applying Bid Modifiers to Creatives.
It will soon support the folloowing dimensions: Location (City, State, Zip), Device, and Inventory (Open Exchange, Publisher Category, Deal ID).
API Comparison
Base URLs
IQM: https://app.iqm.com
Xandr: https://api.appnexus.com
| Action | IQM Endpoint | Xandr Endpoint | Notes |
|---|---|---|---|
| Add Bid Modeling | /api/v3/bm/campaigns/{campaignId}/bid-models | /custom-model | |
| Add Bid Modeling to Insertion Order | /api/v3/bm/io/{ioId}/bid-models | n/a | Add Bid Modeling to an Insertion Order and its associated Campaigns. |
| Update Bid Modeling | /api/v3/bm/campaigns/{campaignId}/bid-models | /custom-model | |
| Add/Update Multiple Bid Models | /api/v3/bm/campaigns/{campaignId}/bid-models | n/a | IQM endpoint supports adding, updating, and deleting Bid Model data. |
| Get Campaign Bid Model Details | /api/v3/bm/campaigns/{campaignId}/dimensions/count /api/v3/bm/campaigns/{campaignId}/dimension/{dimensionId}/spent /api/v3/bm/campaigns/{campaignId}/bid-models/count | /custom-model | IQM endpoints get counts of dimensions, spending by dimension, and modeled items count by campaignId. Xandr endpoint supports getting a list of Models or by id. |
| Include/Exclude Management | /api/v2/cmp/deviceType/includeExclude /api/v2/cmp/exchange/includeExclude /api/v2/cmp/trafficsource/includeExclude /api/v3/bm/campaigns/{campaignId}/include-Exclude/dimensions/{dimensionId} | /line-item | IQM has separate endpoints for including/excluding device types, exchanges, traffic sources, and dimensions.Xandr specifies include/exclude management with the supply_strategies object when creating or updating a Line Item. |
More Bid Model Resources
IQM:
Xandr: